<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0; 
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }
		
		.term {
			font: italic 16px verdana, sans-serif;
			font-weight: normal;
		}	
		
		.type {
			font: normal 16px verdana, sans-serif !important;
		}			
		
		.parameter { 
			font-style: italic; 
			}

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
			padding-top: 10px;
			padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }
		
		span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }
		
        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }
		
        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
			margin-top: 10px;
            background-color: #FFF;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
			font: normal 16px verdana, sans-serif;
        }
		
        div.refsect1 th {
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }
		
        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }
		
		  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }
		

        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
			white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }
					
</style>
    <title>vload[n]</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="                            &#10;                vloadn&#10;            " />
  </head>
  <body>
    <div class="refentry">
      <a id="idm1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="vloadn"></a>
        <h1>vloadn</h1>
        <p>
            Read vectors from a pointer to memory.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    gentype<em class="replaceable">n</em>
                    <strong class="fsfunc">                   
                        vload<em class="replaceable">n</em>
                    </strong>
                (</code>
                <td>
					<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">offset</var>
				, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const 
					<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="global.html" target="_top">__global</a> gentype
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*p</var><code>)</code></td>
            </tr>
          </table>
        </div>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    gentype<em class="replaceable">n</em>
                    <strong class="fsfunc">                   
                        vload<em class="replaceable">n</em>
                    </strong>
                (</code>
                <td>
					<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">offset</var>
				, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="local.html" target="_top">__local</a> gentype
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*p</var>
				<code>)</code></td>
            </tr>
          </table>
        </div>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    gentype<em class="replaceable">n</em>
                    <strong class="fsfunc">                   
                        vload<em class="replaceable">n</em>
                    </strong>
                (</code>
                <td>
					<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">offset</var>
				, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="constant.html" target="_top">__constant</a> gentype
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*p</var>
				<code>)</code></td>
            </tr>
          </table>
        </div>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    gentype<em class="replaceable">n</em>
                    <strong class="fsfunc">                   
                        vload<em class="replaceable">n</em>
                    </strong>
                (</code>
                <td>
					<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">size_t</a>
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">offset</var>
				, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="private.html" target="_top">__private</a> gentype
					 <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*p</var>
				<code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
		Return sizeof (<span class="type">gentype<em class="replaceable"><code>n</code></em></span>) bytes of data read from location (<code class="varname">p</code> + (<code class="varname">offset</code> * <code class="varname">n</code>)). 
        </p>
        <p>
		</p>
        <p>
The read address computed as (<code class="varname">p</code> + (<code class="varname">offset</code> * <code class="varname">n</code>)) must be 8-bit aligned if <span class="type">gentype</span> is <span class="type">char<em class="replaceable"><code>n</code></em></span>, <span class="type">uchar<em class="replaceable"><code>n</code></em></span>; 16-bit aligned if <span class="type">gentype</span> is <span class="type">short<em class="replaceable"><code>n</code></em></span>, <span class="type">ushort<em class="replaceable"><code>n</code></em></span>; 32-bit aligned if gentype is <span class="type">int<em class="replaceable"><code>n</code></em></span>, <span class="type">uint<em class="replaceable"><code>n</code></em></span>, <span class="type">float<em class="replaceable"><code>n</code></em></span>; 64-bit aligned if <span class="type">gentype</span> is <span class="type">long<em class="replaceable"><code>n</code></em></span>, <span class="type">ulong<em class="replaceable"><code>n</code></em></span>. 
        </p>
        <p>
If the <span class="type">double</span> extension is enabled, then in addition to the above the read address must be 64-bit aligned if <span class="type">gentype</span> is <span class="type">long<em class="replaceable"><code>n</code></em></span>, <span class="type">ulong<em class="replaceable"><code>n</code></em></span>, or <span class="type">double<em class="replaceable"><code>n</code></em></span>.
		</p>
        <p>
If the <span class="type">half</span> extension is enabled, the read address computed as (<code class="varname">p</code> + (<code class="varname">offset</code> * <code class="varname">n</code>) must be 16-bit aligned.
		</p>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
		The generic type <span class="type">gentype</span> is used to indicate the built-in data types 
<span class="type">char</span>, <span class="type">uchar</span>, <span class="type">short</span>, <span class="type">ushort</span>, <span class="type">int</span>, <span class="type">uint</span>, <span class="type">long</span>, <span class="type">ulong</span>, or <span class="type">float</span>. 
        </p>
        <p>
The generic type name <span class="type">gentype<em class="replaceable"><code>n</code></em></span> is used to indicate the built-in data types <span class="type">char{2|4|8|16}</span>,
<span class="type">uchar{2|4|8|16}</span>, <span class="type">short{2|4|8|16}</span>, <span class="type">ushort{2|4|8|16}</span>,
<span class="type">int{2|4|8|16}</span>, <span class="type">uint{2|4|8|16}</span>, <span class="type">long{2|4|8|16}</span>, <span class="type">ulong{2|4|8|16}</span>, or <span class="type">float{2|4|8|16}</span> as the type for the arguments unless otherwise stated. The suffix used in gentype<em class="replaceable"><code>n</code></em> or the function name (i.e. <code class="function">vload<em class="replaceable"><code>n</code></em></code>, <code class="function">vstore<em class="replaceable"><code>n</code></em></code>, etc.) represents the number of elements in the built-in vector type (<em class="replaceable"><code>n</code></em> = 2, 4, 8, or 16).
        </p>
        <p>
		If the <span class="type">double</span> extension is enabled with <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a>, the vector data load (<code class="function">vload<em class="replaceable"><code>n</code></em></code>) and store (<code class="function">vstore<em class="replaceable"><code>n</code></em></code>) functions are extended to include versions that read from or write to double scalar or vector values. The generic type <span class="type">gentype</span> is extended to include double and the generic type <span class="type">gentype<em class="replaceable"><code>n</code></em></span> is extended to include <span class="type">double{2|4|8|16}</span> as arguments and return values.  
		</p>
        <p>
		If the <span class="type">half</span> extension is enabled with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>, the vector data load (<code class="function">vload<em class="replaceable"><code>n</code></em></code>) and store (<code class="function">vstore<em class="replaceable"><code>n</code></em></code>) functions are extended to include versions that read from or write to half scalar or vector values. The generic type <span class="type">gentype</span> is extended to include <span class="type">half</span> and the generic type <span class="type">gentype<em class="replaceable"><code>n</code></em></span> is extended to include <span class="type">half{2|4|8|16}</span> as arguments and return values. 
		</p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />
                                                 
            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.0.pdf#page=186" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="vectorDataLoadandStoreFunctions.html"><span class="citerefentry"><span class="refentrytitle">Vector Data Load and Store Functions</span></span></a> 
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2009 The Khronos Group Inc. 
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials. 
</div>
    </div>
  </body>
</html>
